pp108 : Managing Logging Framework

Managing Logging Framework

This topic describes the features and functions of Process Platform Logging Framework.


The logging framework is a key feature of Process Platform that records certain critical activities during runtime. It is based on Log4j and is used for debugging.

The information gathered from the log files is used to analyze the error state and fix support calls. Process Platform supports different kinds of log consumers such as file, event service, and so on, including those from Log4j. This framework provides a web-based log viewer for viewing the messages. Apache's Chainsaw is an open source GUI-based tool that can also be used for viewing the log messages. Composite Application Logging (CAL) is an extension of Logging Framework which facilitates application level logging.

Logging framework helps the support personnel or developers or administrators to analyze the error states. Refer to Logging Framework Process for information on the overall working of logging framework.

Examples of Log Messages


Examples of log statements are:

  • License key has been validated.
  • Request has been received.
  • Response has been sent.
  • An exception occurred.
    Refer to Log Message Formats to view the format of few sample log messages.
    Log Consumers uses these log messages. Process Platform supports various kinds of log consumers, including those from Log4j, for consuming log messages.
    Process Platform provides a classification of error messages. This helps you categorize the error messages and assign an appropriate severity level to the same. Refer to Categories and Severity Levels for more information on categories and associated severity levels used by the framework.
    Note: The log4j's internal logging mechanism called as
    LogLog is disabled by default. To enable it, set com.cordys.management.log4j.internallogging to true in the Platform Properties.
    This section contains the following topics:

  • Providing Log Configuration details - Describes how to provide log configuration details.
  • Viewing Log Messages - Explains how to use the log viewer.

Related tasks

Enabling Event Logging at System and Individual Component Level

Related information

Composite Application Logging
Auditing
Working with Logging Framework